home *** CD-ROM | disk | FTP | other *** search
/ Utilities Professional 1-1500 / Utilities Professional 1-1500 (1994)(WPD)[!].iso / 10011250 / var1219.dms / var1219.adf / ARexxGuide / ARexxGuide1_0.README < prev    next >
Text File  |  1992-09-02  |  5KB  |  142 lines
  1. Short: Complete ARexx reference. AmigaGuide.
  2. Type: AmigaGuide
  3. Uploader: R.EVANS6
  4. Author: R.EVANS6
  5.  
  6. DESCRIPTION
  7. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  8. This is a complete ARexx reference with tutorials and examples. It includes
  9. argument templates and descriptions of all instruction keywords, of
  10. built-in functions and of the functions in rexxsupport.library. The basic
  11. elements of the language are fully explained.
  12.  
  13. It is a shareware offering. The suggested fee is $15.
  14.  
  15. ARCHIVE CONTENTS
  16. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  17. The ARexxGuide drawer of this archive contains 20 files that make up one
  18. AmigaGuideĀ® application. The AmigaGuide files are:
  19.  
  20.   ArexxGuide.guide                 ArexxGuide.guide.info
  21.   ARx_Cmd.ag                       ARx_Elements.ag
  22.   ARx_Elements2.ag                 ARx_Elements3.ag
  23.   ARx_Func.ag                      ARx_Func2.ag
  24.   ARx_Func3.ag                     ARx_Func4.ag
  25.   ARx_Index                        ARx_Instr.ag
  26.   ARx_Instr2.ag                    ARx_Instr3.ag
  27.   ARx_Intro.ag                     ARx_Notes.ag
  28.   ARx_Operator.ag                  ARx_PrgUcr.ag
  29.   ARx_UcrTutor1.ag                 ARx_UcrTutor2.ag
  30.  
  31. Only ARexxGuide.guide is intended as an AmigaGuide executable. The other
  32. files are called from within the main node of that guide.
  33.  
  34. The following ARexx script files, located in the same directory, are used
  35. to run interactive examples from ARexxGuide:
  36.  
  37.   ARx_Cmpr.rexx                    ARx_IactExamples.rexx
  38.   ARx_Reg.rexx                     Arx_Trace.rexx
  39.  
  40. The 'Extras' drawer contains some files that are not necessary, but may be
  41. helpful to some users. A Readme file in that directory explains those files.
  42.  
  43. The file 'UnCrunch.rexx' is the the source document for the program
  44. included in the tutorial section.
  45.  
  46. INSTALLATION
  47. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  48. The ARexxGuide drawer can be moved to any location.
  49.  
  50. The #?.rexx files in the drawer may, optionally, be moved to the system
  51. REXX: directory. The following command will do that:
  52.  
  53.     copy <path>/ARexxGuide/#?.rexx REXX:
  54.     delete <path>/ARexxGuide/#?.rexx
  55.  
  56. RUNNING ARexxGuide
  57. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  58. From the icon:
  59.     Double-click on the ARexxGuide.guide icon. ARexxGuide will open its
  60.     window.
  61.  
  62.     The default tool in the icon is 'AmigaGuide' without path specification.
  63.     If your AmigaGuide executable program is located in a path that is
  64.     searched by Workbench, then that will be enough. If, however, AmigaGuide
  65.     cannot be found by Workbench, then you should single-click on the icon
  66.     and press Amiga-I.  Add the full path to the 'Default tool:' field in
  67.     the Information window.
  68.  
  69.             Example:
  70.                     sys:utilities/Amigaguide
  71.  
  72.     If you use Multiview instead of AmigaGuide, then you may need to change
  73.     the default tool.
  74.  
  75.     When ARexxGuide is called from the icon, the .rexx interactive examples
  76.     will run, even if they are not moved to the rexx: directory.
  77.  
  78. From a shell:
  79.     You have more options when you run ARexxGuide from a shell, but may
  80.     also run into a few more problems because this guide uses multiple
  81.     files. When pressing one of the link buttons in the guide, AmigaGuide
  82.     will often look for one of the subsidiary files. It will find them if
  83.     they are in the current directory or if they are in a path included in
  84.     the AmigaGuide/path environmental variable.
  85.  
  86.  --- Run ARexxGuide from the current directory.
  87.  
  88.     Make the directory containing ARexxGuide.guide the current directory
  89.     before calling the guide:
  90.  
  91.         Example:
  92.             cd <path>/ARexxGuide
  93.             Amigaguide ARexxGuide.guide
  94.  
  95.     Interactive .rexx examples will run even if they are not moved to REXX:
  96.     when the guide is invoked this way.
  97.  
  98.  --- Add the ARexxGuide path the AmigaGuide search path.
  99.  
  100.     AmigaGuide will look for files in directories specified in the
  101.     environmental variable amigaguide/path. If you often run this guide from
  102.     a shell or directory utility, you should probably set the variable.
  103.  
  104.     The following command, issued from a shell, will set a search path for
  105.     AmigaGuide:
  106.  
  107.         makedir env:amigaguide
  108.         setenv amigaguide/path <path>/ARexxGuide
  109.  
  110.     where <path> is the full path leading to the directory.
  111.  
  112.     If you've already created an 'amigaguide' path in env:, then you may
  113.     omit the makedir command.
  114.  
  115.     Note that this command will replace any value that might previously have
  116.     been set for the path variable. You can, however, include multiple paths
  117.     in that variable. Just separate each path from others with a space and
  118.     use the collection in the 'setenv' command.
  119.  
  120.     The env: directory is located by default in RAM:, so this setting will
  121.     not survive a reboot. If you'd like to have path automatically set when
  122.     you reboot, issue this command:
  123.  
  124.         copy env:amigaguide/#? envarc:
  125.  
  126.     If that command is issued after you have opened and closed AmigaGuide,
  127.     then the window size and position last used will also be saved.
  128.  
  129.     Once the search path for AmigaGuide is set, ARexxGuide can be run
  130.     without setting the current directory. The interactive examples,
  131.     however, might not run. They should be moved to the REXX: directory to
  132.     so that ARexx will be able to find them.
  133.  
  134.  
  135.                     Robin Evans                            26 Sep 1993
  136.                         R.EVANS6   on GEnie
  137.  
  138.                         from Internet:
  139.                             robin@halcyon.com
  140.                             r.evans6@genie.geis.com
  141.  
  142.